Skip to content

QVAC-17697 Prepare docs website for AI agents#1715

Merged
BrunoCampana merged 13 commits into
mainfrom
docs/add-support-agents
May 1, 2026
Merged

QVAC-17697 Prepare docs website for AI agents#1715
BrunoCampana merged 13 commits into
mainfrom
docs/add-support-agents

Conversation

@BrunoCampana

@BrunoCampana BrunoCampana commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

Goal

Prepare the website for AI agents.

We are using the following tool as the benchmark:
https://isitagentready.com/docs.qvac.tether.io?profile=content

The scope covers everything that was possible to do while keeping the website static and served by a CDN.

If the migration from CDN to a Node server is accepted, the next PR will include that migration and we will add the missing tools.

Scope

  • Added robots.txt autogeneration following RFC 9309
  • Added sitemap.xml autogeneration
  • Improved the rules to ensure that only the latest version of each versioned software is indexed by web crawlers and consumed by AI agents.
  • Added JSON-LD to improve metadata for all pages and improve consumption by web crawlers and AI agents, following Schema.org and JSON-LD standards.
  • Updated all content pages to add new frontmatter for type of page.
  • Simplified website metadata generation.

Task

https://app.asana.com/1/45238840754660/project/1210688448662730/task/1214145679658308?focus=true

Test in staging env:

https://docs.qvac.tether.su/robots.txt

https://docs.qvac.tether.su/sitemap.xml

For JSON-LD, use browser tools:

  • Press Ctrl+U (View Source). Do not use DevTools → Elements — that shows the post-JS DOM, not what crawlers see.
  • Ctrl+F and search for each of these, confirm they're present and look right:
    • ld+json
    • canonical
    • name="robots"
    • og:type

@BrunoCampana BrunoCampana self-assigned this Apr 22, 2026
@BrunoCampana BrunoCampana added documentation Improvements or additions to documentation tier1 labels Apr 22, 2026
@BrunoCampana BrunoCampana requested review from a team as code owners April 22, 2026 23:18

@gatteo gatteo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current llms.txt file does not provide info about the pages in the site, only redirects to llsm.txt - We should update the llms.txt to be an index file with links and descriptions of all pages in the doc website.
You can take inspiration from here: https://llmstxt.site/

@github-actions

github-actions Bot commented Apr 23, 2026

Copy link
Copy Markdown
Contributor

Tier-based Approval Status

**PR Tier:** TIER1

**Current Status:** ✅ APPROVED

**Requirements:**
- 1 Team Member approval ✅ (1/1)
- 1 Team Lead OR Management approval ✅ (1/1)



---
*This comment is automatically updated when reviews change.*

gatteo
gatteo previously approved these changes Apr 30, 2026
@BrunoCampana

Copy link
Copy Markdown
Contributor Author

/review

@BrunoCampana

Copy link
Copy Markdown
Contributor Author

/review

@BrunoCampana BrunoCampana merged commit 77e1236 into main May 1, 2026
8 of 9 checks passed
@BrunoCampana BrunoCampana deleted the docs/add-support-agents branch May 1, 2026 13:49
Proletter pushed a commit that referenced this pull request May 24, 2026
* doc: create Cursor rule for docs website

* docs: add robots.txt to website

* doc: website source - refactor - standardize env vars to standard used in JSON and infra envs like GH Actions

* doc: website source - add autogen sitemap.xml

* doc: website source - add JSON-LD

* doc: frontmatter improvement - add type of page to enrich metadata

* doc: content update - add missing frontmatter field for SEO

* doc: website source - robots.txt - add AI bot rules

* doc: website source - simplify SEO machinery

* doc: website source - robots.txt - add content signals
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tier1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants